home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat3 / Tcl / history.z / history
Text File  |  1998-10-30  |  11KB  |  199 lines
  1.  
  2.  
  3.  
  4. hhhhiiiissssttttoooorrrryyyy((((3333TTTTccccllll))))                                                    hhhhiiiissssttttoooorrrryyyy((((3333TTTTccccllll))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      history - Manipulate the history list
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      hhhhiiiissssttttoooorrrryyyy ?_o_p_t_i_o_n? ?_a_r_g _a_r_g ...?
  13.  
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      The hhhhiiiissssttttoooorrrryyyy command performs one of several operations related to
  17.      recently-executed commands recorded in a history list.  Each of these
  18.      recorded commands is referred to as an ``event''.  When specifying an
  19.      event to the hhhhiiiissssttttoooorrrryyyy command, the following forms may be used:
  20.  
  21.      [1]  A number:  if positive, it refers to the event with that number (all
  22.           events are numbered starting at 1).  If the number is negative, it
  23.           selects an event relative to the current event (----1111 refers to the
  24.           previous event, ----2222 to the one before that, and so on).
  25.  
  26.      [2]  A string:  selects the most recent event that matches the string.
  27.           An event is considered to match the string either if the string is
  28.           the same as the first characters of the event, or if the string
  29.           matches the event in the sense of the ssssttttrrrriiiinnnngggg mmmmaaaattttcccchhhh command.
  30.  
  31.      The hhhhiiiissssttttoooorrrryyyy command can take any of the following forms:
  32.  
  33.      hhhhiiiissssttttoooorrrryyyy
  34.           Same as hhhhiiiissssttttoooorrrryyyy iiiinnnnffffoooo, described below.
  35.  
  36.      hhhhiiiissssttttoooorrrryyyy aaaadddddddd _c_o_m_m_a_n_d ?eeeexxxxeeeecccc?
  37.           Adds the _c_o_m_m_a_n_d argument to the history list as a new event.  If
  38.           eeeexxxxeeeecccc is specified (or abbreviated) then the command is also executed
  39.           and its result is returned.  If eeeexxxxeeeecccc isn't specified then an empty
  40.           string is returned as result.
  41.  
  42.      hhhhiiiissssttttoooorrrryyyy cccchhhhaaaannnnggggeeee _n_e_w_V_a_l_u_e ?_e_v_e_n_t?
  43.           Replaces the value recorded for an event with _n_e_w_V_a_l_u_e.  _E_v_e_n_t
  44.           specifies the event to replace, and defaults to the _c_u_r_r_e_n_t event
  45.           (not event ----1111).  This command is intended for use in commands that
  46.           implement new forms of history substitution and wish to replace the
  47.           current event (which invokes the substitution) with the command
  48.           created through substitution.  The return value is an empty string.
  49.  
  50.      hhhhiiiissssttttoooorrrryyyy eeeevvvveeeennnntttt ?_e_v_e_n_t?
  51.           Returns the value of the event given by _e_v_e_n_t.  _E_v_e_n_t defaults to
  52.           ----1111.  This command causes history revision to occur:  see below for
  53.           details.
  54.  
  55.      hhhhiiiissssttttoooorrrryyyy iiiinnnnffffoooo ?_c_o_u_n_t?
  56.           Returns a formatted string (intended for humans to read) giving the
  57.           event number and contents for each of the events in the history list
  58.           except the current event.  If _c_o_u_n_t is specified then only the most
  59.           recent _c_o_u_n_t events are returned.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. hhhhiiiissssttttoooorrrryyyy((((3333TTTTccccllll))))                                                    hhhhiiiissssttttoooorrrryyyy((((3333TTTTccccllll))))
  71.  
  72.  
  73.  
  74.      hhhhiiiissssttttoooorrrryyyy kkkkeeeeeeeepppp _c_o_u_n_t
  75.           This command may be used to change the size of the history list to
  76.           _c_o_u_n_t events.  Initially, 20 events are retained in the history
  77.           list.  This command returns an empty string.
  78.  
  79.      hhhhiiiissssttttoooorrrryyyy nnnneeeexxxxttttiiiidddd
  80.           Returns the number of the next event to be recorded in the history
  81.           list.  It is useful for things like printing the event number in
  82.           command-line prompts.
  83.  
  84.      hhhhiiiissssttttoooorrrryyyy rrrreeeeddddoooo ?_e_v_e_n_t?
  85.           Re-executes the command indicated by _e_v_e_n_t and return its result.
  86.           _E_v_e_n_t defaults to ----1111.  This command results in history revision:
  87.           see below for details.
  88.  
  89.      hhhhiiiissssttttoooorrrryyyy ssssuuuubbbbssssttttiiiittttuuuutttteeee _o_l_d _n_e_w ?_e_v_e_n_t?
  90.           Retrieves the command given by _e_v_e_n_t (----1111 by default), replace any
  91.           occurrences of _o_l_d by _n_e_w in the command (only simple character
  92.           equality is supported; no wild cards), execute the resulting
  93.           command, and return the result of that execution.  This command
  94.           results in history revision:  see below for details.
  95.  
  96.      hhhhiiiissssttttoooorrrryyyy wwwwoooorrrrddddssss _s_e_l_e_c_t_o_r ?_e_v_e_n_t?
  97.           Retrieves from the command given by _e_v_e_n_t (----1111 by default) the words
  98.           given by _s_e_l_e_c_t_o_r, and return those words in a string separated by
  99.           spaces.  The sssseeeelllleeeeccccttttoooorrrr argument has three forms.  If it is a single
  100.           number then it selects the word given by that number (0000 for the
  101.           command name, 1111 for its first argument, and so on).  If it consists
  102.           of two numbers separated by a dash, then it selects all the
  103.           arguments between those two.  Otherwise sssseeeelllleeeeccccttttoooorrrr is treated as a
  104.           pattern; all words matching that pattern (in the sense of ssssttttrrrriiiinnnngggg
  105.           mmmmaaaattttcccchhhh) are returned.  In the numeric forms $$$$ may be used to select
  106.           the last word of a command.  For example, suppose the most recent
  107.           command in the history list is
  108.  
  109.                ffffoooorrrrmmmmaaaatttt  {{{{%%%%ssss iiiissss %%%%dddd yyyyeeeeaaaarrrrssss oooolllldddd}}}} AAAAlllliiiicccceeee [[[[eeeexxxxpppprrrr $$$$aaaaggggeeeeIIIInnnnMMMMoooonnnntttthhhhssss////11112222]]]]
  110.  
  111.           Below are some history commands and the results they would produce:
  112.  
  113.  
  114.                hhhhiiiissssttttoooorrrryyyy wwwwoooorrrrddddssss $$$$ [[[[eeeexxxxpppprrrr $$$$aaaaggggeeeeIIIInnnnMMMMoooonnnntttthhhhssss////11112222]]]]
  115.                hhhhiiiissssttttoooorrrryyyy wwwwoooorrrrddddssss 1111----2222{{{{%%%%ssss iiiissss %%%%dddd yyyyeeeeaaaarrrrssss  oooolllldddd}}}} AAAAlllliiiicccceeee
  116.                hhhhiiiissssttttoooorrrryyyy wwwwoooorrrrddddssss ****aaaa****oooo****{{{{%%%%ssss iiiissss %%%%dddd yyyyeeeeaaaarrrrssss oooolllldddd}}}} [[[[eeeexxxxpppprrrr $$$$aaaaggggeeeeIIIInnnnMMMMoooonnnntttthhhhssss////11112222]]]]
  117.  
  118.           HHHHiiiissssttttoooorrrryyyy wwwwoooorrrrddddssss results in history revision:  see below for details.
  119.  
  120. HHHHIIIISSSSTTTTOOOORRRRYYYY RRRREEEEVVVVIIIISSSSIIIIOOOONNNN
  121.      The history options eeeevvvveeeennnntttt, rrrreeeeddddoooo, ssssuuuubbbbssssttttiiiittttuuuutttteeee, and wwwwoooorrrrddddssss result in
  122.      ``history revision''.  When one of these options is invoked then the
  123.      current event is modified to eliminate the history command and replace it
  124.      with the result of the history command.  For example, suppose that the
  125.      most recent command in the history list is
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. hhhhiiiissssttttoooorrrryyyy((((3333TTTTccccllll))))                                                    hhhhiiiissssttttoooorrrryyyy((((3333TTTTccccllll))))
  137.  
  138.  
  139.  
  140.           sssseeeetttt aaaa [[[[eeeexxxxpppprrrr $$$$bbbb++++2222]]]]
  141.  
  142.      and suppose that the next command invoked is one of the ones on the left
  143.      side of the table below.  The command actually recorded in the history
  144.      event will be the corresponding one on the right side of the table.
  145.  
  146.  
  147.           hhhhiiiissssttttoooorrrryyyy rrrreeeeddddoooo    sssseeeetttt aaaa [[[[eeeexxxxpppprrrr $$$$bbbb++++2222]]]]
  148.           hhhhiiiissssttttoooorrrryyyy ssss aaaa bbbb   sssseeeetttt bbbb [[[[eeeexxxxpppprrrr $$$$bbbb++++2222]]]]
  149.           sssseeeetttt cccc [[[[hhhhiiiissssttttoooorrrryyyy wwww 2222]]]]sssseeeetttt cccc [[[[eeeexxxxpppprrrr $$$$bbbb++++2222]]]]
  150.  
  151.      History revision is needed because event specifiers like ----1111 are only
  152.      valid at a particular time:  once more events have been added to the
  153.      history list a different event specifier would be needed.  History
  154.      revision occurs even when hhhhiiiissssttttoooorrrryyyy is invoked indirectly from the current
  155.      event (e.g. a user types a command that invokes a Tcl procedure that
  156.      invokes hhhhiiiissssttttoooorrrryyyy):  the top-level command whose execution eventually
  157.      resulted in a hhhhiiiissssttttoooorrrryyyy command is replaced.  If you wish to invoke
  158.      commands like hhhhiiiissssttttoooorrrryyyy wwwwoooorrrrddddssss without history revision, you can use hhhhiiiissssttttoooorrrryyyy
  159.      eeeevvvveeeennnntttt to save the current history event and then use hhhhiiiissssttttoooorrrryyyy cccchhhhaaaannnnggggeeee to
  160.      restore it later.
  161.  
  162.  
  163. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  164.      event, history, record, revision
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.